Kanzi 3.9.10
kanzi::TrajectoryListBox3D Class Reference

Use the Trajectory List Box 3D node to create scrollable lists of items arranged along a Trajectory. More...

#include <kanzi/ui/node/trajectory_list_box3d.hpp>

Inheritance diagram for kanzi::TrajectoryListBox3D:
[legend]

Public Member Functions

ScrollView3DSharedPtr getScrollView () const
 Returns the Scroll View that scrolls the Trajectory List Box 3D.
 
- Public Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >
bool addContentItem (NodeSharedPtr abstractItem) override
 
void addItem (ItemSharedPtr item)
 Adds an item at the end of a List Box when using the default object generator.
 
void arrangeOverride (LayoutVectorType actualSize) override
 
void bringItemCenter (size_t itemIndex, bool smooth)
 Requests the List Box to bring the item in the passed itemIndex to the center of the list box area.
 
void enableKeyNavigation (bool enabled)
 Enables directional key navigation on the List Box.
 
optional< pair< size_t, size_t > > getAliveRange ()
 Returns the range of list items that are alive.
 
NodeSharedPtr getContentItem (size_t index) override
 
size_t getContentItemCount () override
 
ItemSharedPtr getItem (size_t index)
 Gets the item at the given index in a List Box.
 
string getItemContainerGeneratorTypeName () const
 Gets the value of ItemContainerGeneratorTypeNameProperty.
 
PrefabTemplateSharedPtr getItemContainerTemplate () const
 Gets the value of ItemContainerTemplateProperty.
 
size_t getItemCount () const
 Returns the value of the ItemCountProperty.
 
string getItemGeneratorTypeName () const
 Gets the value of ItemGeneratorTypeNameProperty.
 
optional< size_t > getItemIndex (ItemSharedPtr item)
 Returns the index of the given item. If the item does not exist, returns empty.
 
LayoutVectorType getItemSize (size_t index)
 Returns the size of the item at the given index.
 
PrefabTemplateSharedPtr getItemTemplate () const
 Gets the value of ItemTemplateProperty.
 
int getKeepAliveItemCount () const
 Gets the value of KeepAliveItemCountProperty.
 
PresenterSharedPtr getPresenter () const
 
int getSelectedItemIndex () const
 Gets the value of SelectedItemIndexProperty.
 
SelectionBehavior getSelectionBehavior () const
 Gets the value of SelectionBehavior.
 
void insertItem (size_t index, ItemSharedPtr item)
 Inserts an item at the given index in a List Box when using the default object generator.
 
bool isEmpty ()
 Indicates whether a List Box has no items.
 
LayoutVectorType measureOverride (LayoutVectorType availableSize) override
 
void notifyItemAdded (size_t index) override
 Virtual functions for notifying item changes to list.
 
void notifyItemContainerChanged ()
 
void notifyItemCountChanged () override
 
void notifyItemRemoved (size_t index) override
 
void notifyItemReplaced (size_t index) override
 
void removeAllContentItems () override
 
void removeAllItems ()
 Removes all items from a List Box when using the default object generator.
 
bool removeContentItem (NodeSharedPtr abstractItem) override
 
void removeItem (size_t index)
 Removes the item at the given index from a List Box when using the default object generator.
 
void removeLastItem ()
 Removes the last item from a List Box when using the default object generator.
 
void replaceItem (size_t index, ItemSharedPtr item)
 Replaces the item at the given index in a List Box when using the default object generator.
 
void selectItem (optional< size_t > itemIndex)
 Requests the List Box to select the item at the given index.
 
void setItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Sets the list box item container generator.
 
void setItemContainerGeneratorTypeName (string_view value)
 Sets the value of ItemContainerGeneratorTypeNameProperty.
 
void setItemContainerTemplate (PrefabTemplateSharedPtr value)
 Sets the value of ItemContainerTemplateProperty.
 
void setItemGenerator (ItemGeneratorSharedPtr itemGenerator)
 Sets the list box item generator.
 
void setItemGeneratorTypeName (string_view value)
 Sets the value of ItemGeneratorTypeNameProperty.
 
void setItemTemplate (PrefabTemplateSharedPtr value)
 Sets the value of ItemTemplateProperty.
 
void setKeepAliveItemCount (int value)
 Sets the value of KeepAliveItemCountProperty.
 
void setSelectedItemIndex (int value)
 Sets the value of SelectedItemIndexProperty.
 
void setSelectionBehavior (SelectionBehavior value)
 Sets the value of SelectionBehavior.
 
void updateVisibleRange (size_t beginIndex, size_t itemCount)
 Requests items from the item generator.
 
void updateVisibleRange (size_t beginIndex, size_t itemCount, bool sendMessages)
 
void updateVisibleRangeQuiet (size_t beginIndex, size_t itemCount)
 Requests items from the item generator.
 
- Public Member Functions inherited from kanzi::Node3D
bool addAbstractChildOverride (NodeSharedPtr child) override
 
void addChild (const Node3DSharedPtr &child)
 Adds a child node to a 3D node.
 
void arrange ()
 Performs layout arrangement on a 3D node.
 
void arrangeIterate ()
 Initial scene arrange.
 
void arrangeIterateLayout (bool propagateArrange)
 
void arrangeIterateLayoutChild (bool propagateArrange)
 
ChildConstIterator beginChildren () const
 
void centeredArrange (Vector3 actualSize) const
 Default implementation of arrange for a layout that accommodates all children at its center.
 
Vector3 centeredMeasure (Vector3 availableSize) const
 Default implementation of measure for a layout that accommodates all children at its center.
 
ChildConstIterator endChildren () const
 
const RenderEntryParameterContainergenerateRenderStates (DrawObjectsRenderPass &drawPass)
 Gets a listing of render entry parameters to use to generate render states.
 
size_t getAbstractChildCountOverride () override
 
size_t getAbstractChildIndexOverride (const Node &node) override
 
NodeSharedPtr getAbstractChildOverride (size_t index) override
 
Vector3 getActualSize () const
 Returns the actual size of a 3D node.
 
Vector3 getAllocatedOffset () const
 Returns the allocated offset of a 3D node.
 
Vector3 getAllocatedSize () const
 Returns the allocated size of a 3D node.
 
Matrix4x4 getArrangeTransformation () const
 Returns the layout transformation of a 3D node.
 
virtual optional< BoxgetBoundingBox () const
 Gets the bounding box of a 3D node.
 
Node3DSharedPtr getChild (size_t index) const
 Gets a child node at a given index.
 
size_t getChildCount () const
 Gets the number of child nodes in a 3D node.
 
size_t getChildIndex (const Node &child) const
 Gets the index of a child node.
 
Vector3 getCoreDesiredSize () const
 Returns the core desired size of a 3D node.
 
Vector3 getDesiredSize () const
 Returns the desired size of a 3D node.
 
Node3DSharedPtr getFaceToCameraTarget () const
 
void getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
 Returns the size of the bounding box of a 3D node.
 
Node3DSharedPtr getLookAtTarget () const
 
Vector3 getMaximumBoundingBoxCoordinates () const
 Returns the maximum coordinates for the bounding volume of a 3D node.
 
Vector3 getMinimumBoundingBoxCoordinates () const
 Returns the minimum coordinates for the bounding volume of a 3D node.
 
Node3DSharedPtr getOrientationConstraintTarget () const
 
Vector3 getPivotOffset () const
 Returns the pivot offset of a 3D node.
 
Node3DSharedPtr getPositionConstraintTarget () const
 
RenderMode getRenderMode () const
 Returns the render mode.
 
Vector3 getSize () const
 Returns the size of a 3D node.
 
Vector3 getStretchScale () const
 Returns the stretch scale of a 3D node.
 
bool hasChild (const Node &child) const
 Returns whether a child node exists.
 
virtual pair< NodeSharedPtr, floathitTestContent (const Ray &ray)
 Default hit test implementation of Node3D content.
 
void insertChild (size_t index, const Node3DSharedPtr &child)
 Adds to a 3D node a child node at a given index.
 
bool isPrimitiveLayout () const
 Indicates whether a 3D node has primitive layout behavior.
 
void layout ()
 Calculates the layouts in a scene recursively. Calls the measure and arrange functions of every 3D node in the scene.
 
void measure (const Vector3 &availableSize)
 Performs the default measure step.
 
void measureIterate ()
 Initial scene measure.
 
virtual bool measureRecursive ()
 Performs layout measurement for a 3D node.
 
bool moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
 Node::moveAbstractChildToPosition() implementation.
 
void moveChildToPosition (Node3DSharedPtr child, size_t index)
 Moves a child node to a given position in the list of child nodes.
 
void moveToBack ()
 Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first.
 
void moveToFront ()
 Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last.
 
virtual void onTransform ()
 Per-node step performed on transform, after Kanzi calculates the final transformation.
 
ChildConstReverseIterator rbeginChildren () const
 
void registerDrawPass (DrawObjectsRenderPassSharedPtr drawPass)
 Registers a DrawObjectsRenderPass that renders a 3D node.
 
bool removeAbstractChildOverride (Node &child) override
 
void removeAllChildren ()
 Removes all child nodes from a 3D node.
 
void removeChild (const Node &child)
 Removes a child node from a 3D node.
 
void removeChild (size_t index)
 Removes from a 3D node a child node at a given index.
 
ChildConstReverseIterator rendChildren () const
 
void render (Renderer3D &renderer, RenderEntry3D &renderEntry)
 Renders a 3D node using a given render state.
 
void setActualSize (const Vector3 &actualSize)
 Sets the actual size of a 3D node.
 
void setAllocatedOffset (const Vector3 &allocatedOffset)
 Sets the allocated offset of a 3D node.
 
void setAllocatedSize (const Vector3 &layoutSize)
 Sets the allocated size of a 3D node.
 
void setArrangeTransformation (const Matrix4x4 &value)
 Sets the layout transformation of a 3D node.
 
void setAutoDepth ()
 Sets a node to determine its depth automatically.
 
void setAutoHeight ()
 Sets a node to determine its height automatically.
 
void setAutoSize ()
 Sets a node to determine its width, height, and depth automatically.
 
void setAutoWidth ()
 Sets a node to determine its width automatically.
 
void setCoreDesiredSize (const Vector3 &coreDesiredSize)
 Sets the core desired size of a 3D node.
 
void setDesiredSize (const Vector3 &desiredSize)
 Sets the desired size of a 3D node.
 
void setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
 Sets the size of the bounding box of a 3D node.
 
void setPivotOffset (const Vector3 &pivotOffset)
 Sets the pivot offset of a 3D node.
 
void setRenderMode (RenderMode mode)
 Sets the render mode.
 
void setSize (float width, float height, float depth)
 Sets the dimensions of a node.
 
void setSize (Vector3 size)
 Sets the dimensions of a node.
 
void setStretchScale (const Vector3 &stretchScale)
 Sets the stretch scale of a 3D node.
 
 ~Node3D () override
 
Matrix4x4 getFinalTransformation () const
 Gets the value of the FinalTransformationProperty.
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of the FinalTransformationProperty.
 
float getFrustumCullMargin () const
 Gets the value of the FrustumCullMarginProperty.
 
void setFrustumCullMargin (float value)
 Sets the value of the FrustumCullMarginProperty.
 
SRTValue3D getRenderTransformation () const
 Gets the value of the RenderTransformationProperty.
 
void setRenderTransformation (SRTValue3D value)
 Sets the value of the RenderTransformationProperty.
 
SRTValue3D getLayoutTransformation () const
 Gets the value of the LayoutTransformationProperty.
 
void setLayoutTransformation (SRTValue3D value)
 Sets the value of the LayoutTransformationProperty.
 
- Public Member Functions inherited from kanzi::Node
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
 
template<typename T >
shared_ptr< TacquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type.
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource.
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets a resource dictionary of a node.
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node.
 
void addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node.
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function.
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object.
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where the handler is a function.
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source.
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where the handler is a method that is invoked on an object.
 
void addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node.
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component.
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. *‍/.
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Adds a nested resource dictionary to the resource dictionary of a node.
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference.
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object.
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function.
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source.
 
AppliedStyleEntrySharedPtr applyManualStyle (StyleSharedPtr style)
 Applies a style to an object node.
 
AppliedStyleEntrySharedPtr applyStyle (StyleSharedPtr style)
 Applies a style to an object node.
 
void applyStyles ()
 Apply all styles for an object node.
 
void applyStylesRecursive ()
 Applies styles recursively.
 
void attachRecursive ()
 Attaches an object node and its children recursively.
 
InputManipulatorConstIterator beginInputManipulators () const
 
NodeComponentConstIterator beginNodeComponents () const
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag.
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag.
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. *‍/.
 
BindingLookupContextPtr createLookupContext (NodeSharedPtr templateRoot)
 Creates a lookup context for the node.
 
void detachRecursive ()
 Detaches a node and its descendants.
 
void dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
 Dispatches a message from this node with specified arguments.
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message from this node with specified arguments.
 
InputManipulatorConstIterator endInputManipulators () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename TNodeType >
shared_ptr< TNodeTypefindAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene.
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 Tries to find Resource URL for Resource ID from this node.
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
uint32_t getChangeFlags () const
 Get current change flags.
 
uint32_t getChildChangeFlags () const
 Get current child change flags.
 
FocusManagergetFocusManager () const
 Returns the Focus Manager associated with the Screen node to which this node belongs.
 
FocusScopegetFocusScopeInfo () const
 Returns the information about the focus scope for a node.
 
InputManagergetInputManager () const
 Returns the Input Manager associated with the Screen node to which this node belongs.
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
 
NodegetParent () const
 Returns the parent of the node.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property.
 
ResourceDictionarySharedPtr getResourceDictionary () const
 If a node has a resource dictionary, returns the resource dictionary of that node.
 
ScreengetScreen () const
 Returns the Screen node to which this node belongs.
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node.
 
void invalidateArrange ()
 Invalidates arrange.
 
void invalidateDraw ()
 Invalidates draw flag for the node.
 
void invalidateFinalTransform ()
 Invalidates final transform for node.
 
void invalidateMeasure ()
 Invalidates measure for the node.
 
void invalidateRender ()
 Invalidates render for node.
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags is set.
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set.
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants.
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise.
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set.
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match.
 
bool isDetaching () const
 Returns true if the node currently detaching.
 
bool isEffectivelyFocusable () const
 Returns whether a node is focusable.
 
bool isEffectivelyVisible () const
 Returns whether a node and its ancestor nodes are visible.
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise.
 
bool isInvalidArrange () const
 Checks if the node needs arrange.
 
bool isInvalidDraw ()
 Tells if node draw flag is invalid.
 
bool isInvalidFinalTransform () const
 Tells if final transform flag is invalid for node.
 
bool isInvalidMeasure () const
 Check if the node needs measure.
 
bool isInvalidRender () const
 Returns if node render flag is invalid.
 
bool isNamed (string_view name) const
 
 KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias.
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name.
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path.
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node.
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view relativePath)
 Lookup for an object from a node.
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager.
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree.
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources.
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node.
 
void removeKZBData ()
 Destroys all object node data loaded from KZB.
 
void removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
 Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc.
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription.
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node.
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner.
 
void removeNodeReference (const AbstractNodeReference &reference)
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. *‍/.
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference.
 
virtual void restoreResources ()
 Reattaches an object node after potential resource change.
 
void setChangeFlag (uint32_t flag)
 Sets a change flag.
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag.
 
void setParent (Node *parent)
 Kanzi uses this method internally to set the parent of a node.
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of a node.
 
void setScreen (Screen *screen)
 Sets the Screen node to which this node belongs.
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node.
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
 
template<typename T >
shared_ptr< TtryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type.
 
KZ_DEPRECATED NodeSharedPtr trySetActiveFocus ()
 Tries to move the focus on this node.
 
NodeSharedPtr trySetFocus ()
 Tries to move the focus to this node.
 
NodeSharedPtr trySetFocus (FocusFallback fallbackOption)
 Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus.
 
void unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 Unapplies a style from an object node.
 
void unapplyStyles ()
 Unapplies and removes all applied styles.
 
void unapplyStylesRecursive ()
 Unapplies styles recursively.
 
void validateArrange ()
 Validates arrange.
 
void validateDraw ()
 Validates draw flags for the node.
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards.
 
void validateMeasure ()
 Validates measure for the node.
 
void validateRender ()
 Validates render for node.
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 Visits a node and its descendants.
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 Visits the descendants of a node.
 
 ~Node () override
 Destructor.
 
string getName () const
 Gets the value of NameProperty.
 
void setName (string_view value)
 Sets the value of NameProperty.
 
string getPath () const
 Gets the value of PathProperty.
 
void setPath (string value)
 Sets the value of PathProperty.
 
string getLocale () const
 Gets the value of LocaleProperty.
 
void setLocale (string value)
 Sets the value of LocaleProperty.
 
bool isHitTestable () const
 Gets the value of HitTestableProperty.
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty.
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty.
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty.
 
bool isVisible () const
 Gets the value of VisibleProperty.
 
void setVisible (bool value)
 Sets the value of VisibleProperty.
 
bool isEnabled () const
 Returns the value of the EnabledProperty.
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty.
 
bool isEffectivelyEnabled () const
 Returns the value of EffectivelyEnabledProperty.
 
bool isFocusable () const
 Gets the value of the FocusableProperty.
 
void setFocusable (bool value)
 Sets the value of the FocusableProperty.
 
bool isFocused () const
 Gets the value of the FocusedProperty.
 
void setFocused (bool value)
 Sets the value of the FocusedProperty.
 
FocusState getFocusState () const
 Gets the value of the FocusStateProperty.
 
void setFocusState (FocusState state)
 Sets the value of the FocusStateProperty.
 
FontFamilySharedPtr getFontFamily () const
 Gets the font family the node uses.
 
void setFontFamily (FontFamilySharedPtr value)
 Sets the font family the node uses.
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty.
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty.
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty.
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty.
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty.
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty.
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty.
 
void setStateManager (ResourceSharedPtr value)
 Sets the value of StateManagerProperty.
 
float getWidth () const
 Gets the value of WidthProperty.
 
void setWidth (float value)
 Sets the value of WidthProperty.
 
float getHeight () const
 Gets the value of HeightProperty.
 
void setHeight (float value)
 Sets the value of HeightProperty.
 
float getDepth () const
 Gets the value of DepthProperty.
 
void setDepth (float value)
 Sets the value of DepthProperty.
 
float getActualWidth () const
 Gets the value of ActualWidthProperty.
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty.
 
float getActualHeight () const
 Gets the value of ActualHeightProperty.
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty.
 
float getActualDepth () const
 Gets the value of ActualDepthProperty.
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty.
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty.
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty.
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty.
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty.
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty.
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty.
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty.
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty.
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty.
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty.
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty.
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty.
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty.
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty.
 
float getOpacity () const
 Gets the value of OpacityProperty.
 
void setOpacity (float value)
 Sets the value of OpacityProperty.
 
bool isHover () const
 Returns whether the node has HoverProperty set to true.
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty.
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty.
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object.
 
void applyObjectStyles ()
 Apply all styles for an object node.
 
DomaingetDomain () const
 Returns the domain the object belongs to.
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object.
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain.
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object.
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object.
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object.
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object.
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles.
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it.
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers.
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container.
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object.
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object.
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers.
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type.
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers.
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property.
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property.
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value.
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties ()
 Remove all KZB properties.
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set.
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property.
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type.
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
 Sets a binding with no target.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
 Sets a binding with no target.
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding.
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding.
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes.
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes.
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index.
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node.
 
void removeAllBindings ()
 Removes all binding runtimes.
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier.
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner.
 
- Public Member Functions inherited from kanzi::ContentItemCollectionModel
virtual ~ContentItemCollectionModel ()
 

Static Public Member Functions

static TrajectoryListBox3DSharedPtr create (Domain *domain, string_view name)
 Creates a TrajectoryListBox3D node.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >
static Vector2 doMeasure (Node2D &node)
 
static Vector3 doMeasure (Node3D &node)
 
- Static Public Member Functions inherited from kanzi::Node3D
static bool isUnboundedLayoutSize (Vector3 layoutSize)
 Returns whether a layout size is an unbounded layout size.
 
static bool isValidLayoutSize (Vector3 size)
 Returns whether a given size is a valid layout size.
 
static float layoutUp ()
 Returns the direction toward which the y axis of a 3D node grows.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static Vector3 replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
 Replaces any elements in an unbounded layout size with the corresponding elements of a given size.
 
static Vector3 replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
 Replaces any elements in an unbounded layout size with zero.
 
static Vector3 unboundedLayoutSize ()
 Returns an unbounded layout size.
 
- Static Public Member Functions inherited from kanzi::Node
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value.
 
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value.
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it.
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it.
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value.
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 
- Static Public Member Functions inherited from kanzi::ListBoxConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ListBoxScrollingConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

void initialize ()
 
void onAttached () override
 Node::onAttached() implementation.
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation.
 
 TrajectoryListBox3D (Domain *domain, string_view name)
 
- Protected Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >
void applySelectionBehavior (size_t itemIndex, bool smooth)
 Applies selection behavior to the selected item.
 
void assignItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Assigns list box item container generator to list box.
 
void assignItemGenerator (ItemGeneratorSharedPtr itemGenerator)
 Assigns list box item generator to list box.
 
void initialize (PresenterSharedPtr presenter)
 
 ListBoxConceptImpl (Domain *domain, string_view name)
 
bool listBoxContainsKeyFocus () const
 Returns whether the key focus is on the List Box node or on one of the list items.
 
void onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
 Handles ClickManipulator::ClickMessage.
 
void onDetached () override
 Node::onDetached() implementation.
 
void onFocusGained (FocusManager::PostFocusMessageArguments &messageArguments)
 Handles FocusManager::FocusGainedMessage.
 
void setItemContainerGeneratorByProperty ()
 Creates and assigns item container generator by ItemGeneratorTypeName property value.
 
void setItemGeneratorByProperty ()
 Creates and assigns item generator by ItemGeneratorTypeName property value.
 
void synchronizeFocusAndSelection (Node &selectedItemContainer)
 ListBoxConcept uses this function to update the focus in the List Box to the selected item.
 
void synchronizeItemCountProperty ()
 Updates the ItemCountProperty.
 
void synchronizeSelectedItemIndexProperty ()
 Updates the SelectedItemIndexProperty after the List Box internally changes the selected item index.
 
void tryMoveFocusToListBox ()
 Tries to move focus to List Box node itself.
 
void updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo) override
 Overrides Node::updateFocusScopeInfo().
 
void updateGenerators (ItemGeneratorSharedPtr itemGenerator, ItemContainerGeneratorSharedPtr itemContainerGenerator)
 Replaces item and item container generators with new objects. Updates items and layout accordingly.
 
 ~ListBoxConceptImpl () override
 
- Protected Member Functions inherited from kanzi::Node3D
virtual void arrangeOverride (Vector3 actualSize)
 
NodeSharedPtr findAbstractChildOverride (string_view name) override
 
virtual const RenderEntryParameterContainergenerateRenderStatesOverride (DrawObjectsRenderPass &drawPass)
 Node-specific render state generation.
 
void initialize ()
 
virtual Vector3 measureOverride (Vector3 availableSize)
 
 Node3D (Domain *domain, string_view name)
 
void onDetached () override
 Node::onDetached() implementation.
 
virtual void registerDrawPassOverride (DrawObjectsRenderPassSharedPtr drawPass)
 Node-specific implementation of draw pass registration.
 
virtual void renderOverride (Renderer3D &renderer, RenderEntry3D &renderEntry)
 Node-specific rendering implementation.
 
void setPrimitiveLayout (bool primitive)
 Sets primitive layout flag.
 
VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override
 
- Protected Member Functions inherited from kanzi::Node
void attach ()
 Attaches the object node.
 
void detach ()
 Detaches the object node.
 
void initialize ()
 Node-specific initialization.
 
 Node (Domain *domain, string_view name)
 Constructor.
 
void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
 Notifies all property handlers on a property storage.
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during node tree connections.
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during node tree disconnections.
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value.
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source.
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage.
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor.
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor.
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage.
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source.
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers.
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers.
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
NodegetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern.
 
const NodegetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern.
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object.
 
void detachBindings ()
 Detach bindings.
 

Properties

static PropertyType< ResourceSharedPtrTrajectoryProperty
 Sets the resource ID of the Trajectory along which the Trajectory List Box 3D arranges its items.
 
static PropertyType< floatItemAreaBeginProperty
 Defines the starting point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.
 
static PropertyType< floatItemAreaEndProperty
 Defines the ending point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.
 
static PropertyType< Vector2ScrollPositionProperty
 Reports the scroll position of a Trajectory List Box 3D node along the x and y axes as a relative position within the Trajectory List Box 3D 3D area.
 
static PropertyType< boolAlignToTangentProperty
 Indicates whether to align the Trajectory List Box 3D items to match the tangent of the Trajectory.
 
static PropertyType< floatSpacingProperty
 Sets the distance between the items in the Trajectory List Box 3D node.
 
static PropertyType< floatCursorOffsetProperty
 Sets the offset of the position to use to select the active item, in proportional range [0,1].
 
static PropertyType< floatRecognitionThresholdProperty
 Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D node.
 
static PropertyType< intMinimumNumberOfTouchesProperty
 Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling.
 
static PropertyType< intMaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling.
 
static PropertyType< floatSensitivityProperty
 Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of a Trajectory List Box 3D node.
 
static PropertyType< floatSlidingAccelerationCoefficientProperty
 Sets the acceleration of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.
 
static PropertyType< floatSlidingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.
 
static PropertyType< floatDraggingAccelerationCoefficientProperty
 Sets the acceleration of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.
 
static PropertyType< floatDraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.
 
static PropertyType< floatDraggingImpulseFactorProperty
 Sets the amount of impulse to generate from the pointer movement when the user scrolls a Trajectory List Box 3D node by dragging the pointer.
 
static PropertyType< floatSwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value in a Trajectory List Box 3D node, relative to the speed of the pointer.
 
static PropertyType< boolLoopingProperty
 Indicates whether to show items in a Trajectory List Box 3D from the beginning after reaching the last item, and the other way around.
 
static PropertyType< ScrollViewConcept::AllowedScrollAxisAllowedScrollAxisProperty
 Sets the axis on which you want to allow a Trajectory List Box 3D node to scroll.
 
static PropertyType< boolReversedScrollingProperty
 Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture.
 
ResourceSharedPtr getTrajectory () const
 Gets the value of the TrajectoryProperty.
 
void setTrajectory (ResourceSharedPtr value)
 Sets the value of the TrajectoryProperty.
 
float getItemAreaBegin () const
 Gets the value of the ItemAreaBeginProperty.
 
void setItemAreaBegin (float value)
 Sets the value of the ItemAreaBeginProperty.
 
float getItemAreaEnd () const
 Gets the value of the ItemAreaEndProperty.
 
void setItemAreaEnd (float value)
 Sets the value of the ItemAreaEndProperty.
 
Vector2 getScrollPosition () const
 Returns the value of the ScrollPositionProperty.
 
void setScrollPosition (Vector2 scrollPosition)
 Sets the value of the ScrollPositionProperty.
 
bool isAlignToTangent () const
 Gets the value of the AlignToTangentProperty.
 
void setAlignToTangent (bool value)
 Sets the value of the AlignToTangentProperty.
 
float getSpacing () const
 Gets the value of the SpacingProperty.
 
void setSpacing (float value)
 Sets the value of the SpacingProperty.
 
float getCursorOffset () const
 Gets the value of the CursorOffsetProperty.
 
void setCursorOffset (float value)
 Sets the value of the CursorOffsetProperty.
 
float getRecognitionThreshold () const
 Gets the value of the RecognitionThresholdProperty.
 
void setRecognitionThreshold (float value)
 Sets the value of the RecognitionThresholdProperty.
 
int getMinimumNumberOfTouches () const
 Gets the value of the MinimumNumberOfTouchesProperty.
 
void setMinimumNumberOfTouches (int value)
 Sets the value of the MinimumNumberOfTouchesProperty.
 
int getMaximumNumberOfTouches () const
 Gets the value of the MaximumNumberOfTouchesProperty.
 
void setMaximumNumberOfTouches (int value)
 Sets the value of the MaximumNumberOfTouchesProperty.
 
float getSensitivity () const
 Gets the value of the SensitivityProperty.
 
void setSensitivity (float value)
 Sets the value of the SensitivityProperty.
 
float getSlidingAccelerationCoefficient () const
 Gets the value of the SlidingAccelerationCoefficientProperty.
 
void setSlidingAccelerationCoefficient (float value)
 Sets the value of the SlidingAccelerationCoefficientProperty.
 
float getSlidingDragCoefficient () const
 Gets the value of the SlidingDragCoefficientProperty.
 
void setSlidingDragCoefficient (float value)
 Sets the value of the SlidingDragCoefficientProperty.
 
float getDraggingAccelerationCoefficient () const
 Gets the value of the DraggingAccelerationCoefficientProperty.
 
void setDraggingAccelerationCoefficient (float value)
 Sets the value of the DraggingAccelerationCoefficientProperty.
 
float getDraggingDragCoefficient () const
 Gets the value of the DraggingDragCoefficientProperty.
 
void setDraggingDragCoefficient (float value)
 Sets the value of the DraggingDragCoefficientProperty.
 
float getDraggingImpulseFactor () const
 Gets the value of the DraggingImpulseFactorProperty.
 
void setDraggingImpulseFactor (float value)
 Sets the value of the DraggingImpulseFactorProperty.
 
float getSwipeDistance () const
 Gets the value of the SwipeDistanceProperty.
 
void setSwipeDistance (float value)
 Sets the value of the SwipeDistanceProperty.
 
bool isLooping () const
 Gets the value of the LoopingProperty.
 
void setLooping (bool value)
 Sets the value of the LoopingProperty.
 
ScrollViewConcept::AllowedScrollAxis getAllowedScrollAxis () const
 Returns the value of the AllowedScrollAxisProperty.
 
void setAllowedScrollAxis (ScrollViewConcept::AllowedScrollAxis axis)
 Sets the AllowedScrollAxisProperty value.
 
bool isReversedScrolling () const
 Returns the value of the ReversedScrollingProperty.
 
void setReversedScrolling (bool enable)
 Sets the value of the ReversedScrollingProperty.
 

Additional Inherited Members

- Public Types inherited from kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >
typedef shared_ptr< DefaultListBoxItemGenerator< ItemGeneratorClass > > DefaultItemGeneratorSharedPtr
 
typedef ListBoxTraits::TItemClass ItemClass
 
typedef ListBoxTraits::TItemContainerClass ItemContainerClass
 
typedef ListBoxTraits::TItemContainerGeneratorClass ItemContainerGeneratorClass
 
typedef shared_ptr< ItemContainerGeneratorClassItemContainerGeneratorSharedPtr
 
typedef shared_ptr< ItemContainerClassItemContainerSharedPtr
 
typedef ListBoxTraits::TItemGeneratorClass ItemGeneratorClass
 
typedef shared_ptr< ItemGeneratorClassItemGeneratorSharedPtr
 
typedef shared_ptr< ItemClassItemSharedPtr
 
typedef TBaseClass::LayoutVectorType LayoutVectorType
 
typedef ListBoxTraits::TPresenterClass PresenterClass
 
typedef shared_ptr< PresenterClassPresenterSharedPtr
 
- Public Types inherited from kanzi::Node3D
typedef ChildContainer::const_iterator ChildConstIterator
 
typedef ChildContainer::const_reverse_iterator ChildConstReverseIterator
 
typedef vector< Node3DSharedPtrChildContainer
 Iterators for child nodes.
 
typedef Matrix4x4 LayoutMatrixType
 
typedef Vector3 LayoutVectorType
 
using RenderEntryParameterContainer
 The type to use to return render entries from nodes.
 
enum  RenderMode { RenderModeNone , RenderModeDefault , RenderModeCustom }
 Specifies the rendering modes available for a 3D node. More...
 
- Public Types inherited from kanzi::Node
enum  ContentStretch {
  ContentStretchNone , ContentStretchFill , ContentStretchUniform , ContentStretchUniformToFill ,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  DepthAlignment { DepthAlignmentBack , DepthAlignmentFront , DepthAlignmentCenter , DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  HorizontalAlignment { HorizontalAlignmentLeft , HorizontalAlignmentRight , HorizontalAlignmentCenter , HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
typedef InputManipulatorContainer::const_iterator InputManipulatorConstIterator
 
typedef vector< InputManipulatorBaseSharedPtrInputManipulatorContainer
 Gets the input manipulator iterator.
 
typedef InputManipulatorContainer::iterator InputManipulatorIterator
 
typedef kanzi::vector< Node::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
typedef vector< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator.
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
enum  VerticalAlignment { VerticalAlignmentBottom , VerticalAlignmentTop , VerticalAlignmentCenter , VerticalAlignmentStretch }
 Vertical alignment options. More...
 
typedef function< VisitorResult(Node &) Visitor)
 Defines the type of the function that Kanzi executes for each node when visiting a node tree.
 
enum  VisitorOrder { VisitorPreOrder , VisitorPostOrder }
 Defines the order in which Kanzi visits the nodes in a node tree. More...
 
enum  VisitorResult { VisitorAbort , VisitorContinue , VisitorContinueSibling }
 Defines the return type of the Node::Visitor function. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr
 Binding host concept shared pointer type.
 
using BindingRuntimeConstIterator
 Const iterator for binding runtimes.
 
using BindingRuntimeContainer
 Container for binding runtimes.
 
using BindingRuntimeIterator
 Iterator for binding runtimes.
 
- Public Types inherited from kanzi::ListBoxConcept
enum  SelectionBehavior { SelectionBehaviorNone , SelectionBehaviorBringToCenter }
 Behaviors for the List Box when an item in the List Box is selected. More...
 
- Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4FinalTransformationProperty
 Sets the final transformation of a 3D node.
 
static PropertyType< floatFrustumCullMarginProperty
 Sets the margin of the frustum cull radius of a 3D node.
 
static PropertyType< SRTValue3DRenderTransformationProperty
 Sets the render transformation of a 3D node.
 
static PropertyType< SRTValue3DLayoutTransformationProperty
 Sets the transformation of a 3D node relative to its parent node.
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property.
 
static PropertyType< string > PathProperty
 Path property.
 
static PropertyType< string > LocaleProperty
 Locale property.
 
static PropertyType< boolCreatedFromKZBProperty
 CreatedFromKZB property.
 
static PropertyType< boolHitTestableProperty
 HitTestable property.
 
static PropertyType< boolHitTestableContainerProperty
 HitTestableContainer property.
 
static PropertyType< boolVisibleProperty
 Visible property.
 
static PropertyType< boolEnabledProperty
 Sets whether the node is enabled.
 
static PropertyType< boolEffectivelyEnabledProperty
 Indicates whether the node and its ancestor nodes are enabled.
 
static PropertyType< boolFocusableProperty
 Sets whether a node can get focus and can participate in the focus chain navigation.
 
static PropertyType< boolFocusedProperty
 Sets whether a node is an focus node and can receive key messages.
 
static PropertyType< FocusStateFocusStateProperty
 Reports the focus state of a focusable node or focus scope node.
 
static PropertyType< ResourceSharedPtrFontFamilyProperty
 Sets the font family the node uses.
 
static PropertyType< floatVisibleAmountInParentProperty
 VisibleAmountInParent property.
 
static PropertyType< floatProjection2DTo3DScaleProperty
 Projection2DTo3DScale property.
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property.
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 StateManager property.
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property.
 
static PropertyType< floatWidthProperty
 Width property.
 
static PropertyType< floatHeightProperty
 Height property.
 
static PropertyType< floatDepthProperty
 Depth property.
 
static PropertyType< floatActualWidthProperty
 ActualWidth property.
 
static PropertyType< floatActualHeightProperty
 ActualHeight property.
 
static PropertyType< floatActualDepthProperty
 ActualDepth property.
 
static PropertyType< Node::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property.
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property.
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 DepthAlignment property.
 
static PropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
 
static PropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
 
static PropertyType< Vector2DepthMarginProperty
 Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout.
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property.
 
static PropertyType< floatOpacityProperty
 Opacity property.
 
static PropertyType< boolHoverProperty
 Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor.
 
static PropertyType< boolClipChildrenProperty
 ClipChildren property.
 
static PropertyType< intSceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property.
 
static PropertyType< intSceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property.
 
static PropertyType< intSceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property.
 
static PropertyType< intSceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property.
 
- Static Public Attributes inherited from kanzi::ListBoxConcept
static MessageType< ItemHiddenMessageArgumentsItemHiddenMessage
 List Box node dispatches this message whenever the List Box hides one of its items.
 
static MessageType< ItemSelectedMessageArgumentsItemSelectedMessage
 List Box node dispatches this message whenever an item in the List Box is selected.
 
static MessageType< ItemVisibleMessageArgumentsItemVisibleMessage
 List Box node dispatches this message whenever the List Box brings one of its items visible.
 
static PropertyType< intItemCountProperty
 Reports the number of items in a List Box, including virtual items.
 
static PropertyType< intKeepAliveItemCountProperty
 Sets the size of the buffer for invisible List Box items.
 
static PropertyType< ListBoxConcept::SelectionBehaviorSelectionBehaviorProperty
 Sets how a List Box node behaves when the user selects an item.
 
static PropertyType< string > ItemGeneratorTypeNameProperty
 Sets the name of the item generator type to use to provide items dynamically for a List Box node.
 
static PropertyType< string > ItemContainerGeneratorTypeNameProperty
 Sets the name of the item container generator type to use to provide item containers dynamically for a List Box node.
 
static PropertyType< ResourceSharedPtrItemTemplateProperty
 Sets the prefab template to use for the List Box items.
 
static PropertyType< ResourceSharedPtrItemContainerTemplateProperty
 Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the List Box items.
 
static PropertyType< intSelectedItemIndexProperty
 Sets and reports the index of the item that is currently selected in a List Box node.
 
- Static Public Attributes inherited from kanzi::ListBoxScrollingConcept
static MessageType< ScrolledMessageArgumentsScrolledMessage
 List Box node dispatches this message whenever the List Box node scrolls.
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 List Box node dispatches this message whenever the List Box stops scrolling.
 
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 List Box node dispatches this message whenever the List Box starts to scroll.
 
static MessageType< TargetChangedMessageArgumentsTargetChangedMessage
 List Box node dispatches this message whenever there is a change in scroll target item in List Box.
 
static MessageType< UserScrollFinishedMessageArgumentsUserScrollFinishedMessage
 List Box node dispatches this message when the user stops scrolling the List Box content.
 
static MessageType< UserScrollStartedMessageArgumentsUserScrollStartedMessage
 List Box node dispatches this message when the user starts to scroll the List Box content.
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container.
 
- Static Protected Member Functions inherited from kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage.
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw.
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object.
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object.
 

Detailed Description

Use the Trajectory List Box 3D node to create scrollable lists of items arranged along a Trajectory.

Trajectory List Box 3D measures the width of its items and shows those items that fit on the trajectory. To add space between the list items use the SpacingProperty or make the list items artificially wider. If the list is looping and all items fit on the trajectory, Kanzi increases the spacing automatically to distribute the items evenly on the trajectory.

Trajectory List Box 3D has a cursor that is by default positioned in the middle of the trajectory. To move the cursor, use the CursorOffsetProperty. When the user is not giving input to the Trajectory List Box 3D and the scrolling has slowed down, the Trajectory List Box 3D selects the nearest item and snaps it to the cursor.

To handle input, the Trajectory List Box 3D internally uses ScrollView3D. To make the input work:

  1. Position the Trajectory List Box 3D in front of the camera oriented so that the scroll plane is perpendicular to the camera view ray.
  2. Set the size of the Trajectory List Box 3D. The scroll view uses that area to collect input.

To configure the scroll view, Kanzi forwards to the scroll view those scroll view properties that you set in the Trajectory List Box 3D.

See also
ListBoxConceptImpl

Examples

To create a Trajectory List Box 3D node:

// Create a Trajectory List Box 3D named MyListBox.
TrajectoryListBox3DSharedPtr trajectoryListBox = TrajectoryListBox3D::create(domain, "MyListBox");

To set the trajectory that you want the list box to use:

// Create a circle trajectory named Circle with radius of 4 device independent units.
TrajectorySharedPtr trajectory = Trajectory::createCircle(Vector3(), Vector3::positiveY(), 0.0f, 4.0f, domain, "Circle");
// Set the list box to use the trajectory.
trajectoryListBox->setTrajectory(trajectory);
// Increase the layout size to cover the whole trajectory.
trajectoryListBox->setWidth(10.0f);
trajectoryListBox->setDepth(10.0f);
trajectoryListBox->setHeight(3.0f);

To add items to the list box:

// Create cube meshes and add them as items of the Trajectory List Box 3D node.
// Items on the trajectory appear in the order that you add them to the Trajectory List Box 3D node.
Model3DSharedPtr item1 = Model3D::createCube(domain, "item1", 1.0f, ThemeRed);
Model3DSharedPtr item2 = Model3D::createCube(domain, "item2", 1.0f, ThemeGreen);
Model3DSharedPtr item3 = Model3D::createCube(domain, "item3", 1.0f, ThemeBlue);
Model3DSharedPtr item4 = Model3D::createCube(domain, "item4", 1.0f, ThemeOrange);
Model3DSharedPtr item5 = Model3D::createCube(domain, "item5", 1.0f, ThemeYellow);
trajectoryListBox->addItem(item1);
trajectoryListBox->addItem(item2);
trajectoryListBox->addItem(item3);
trajectoryListBox->addItem(item4);
trajectoryListBox->addItem(item5);

To make the list box loop:

// Make the Trajectory List Box 3D node to loop. All items fit to the trajectory so that they are positioned evenly.
trajectoryListBox->setLooping(true);

To set the selection behavior:

// Make clicking items bring them to the center of the trajectory.
trajectoryListBox->setSelectionBehavior(ListBoxConcept::SelectionBehaviorBringToCenter);
// Change the position where the clicked items are brought to be one quarter from the beginning of the trajectory.
trajectoryListBox->setCursorOffset(0.25f);

Constructor & Destructor Documentation

◆ TrajectoryListBox3D()

kanzi::TrajectoryListBox3D::TrajectoryListBox3D ( Domain * domain,
string_view name )
explicitprotected

Member Function Documentation

◆ create()

static TrajectoryListBox3DSharedPtr kanzi::TrajectoryListBox3D::create ( Domain * domain,
string_view name )
static

Creates a TrajectoryListBox3D node.

Parameters
domainThe UI domain to which the node belongs.
nameThe name of the node.

◆ getTrajectory()

ResourceSharedPtr kanzi::TrajectoryListBox3D::getTrajectory ( ) const
inline

Gets the value of the TrajectoryProperty.

See also
setTrajectory()

◆ setTrajectory()

void kanzi::TrajectoryListBox3D::setTrajectory ( ResourceSharedPtr value)
inline

Sets the value of the TrajectoryProperty.

See also
getTrajectory()

◆ getItemAreaBegin()

float kanzi::TrajectoryListBox3D::getItemAreaBegin ( ) const
inline

Gets the value of the ItemAreaBeginProperty.

See also
setItemAreaBegin()

◆ setItemAreaBegin()

void kanzi::TrajectoryListBox3D::setItemAreaBegin ( float value)
inline

Sets the value of the ItemAreaBeginProperty.

See also
getItemAreaBegin()

◆ getItemAreaEnd()

float kanzi::TrajectoryListBox3D::getItemAreaEnd ( ) const
inline

Gets the value of the ItemAreaEndProperty.

See also
setItemAreaEnd()

◆ setItemAreaEnd()

void kanzi::TrajectoryListBox3D::setItemAreaEnd ( float value)
inline

Sets the value of the ItemAreaEndProperty.

See also
getItemAreaEnd()

◆ getScrollPosition()

Vector2 kanzi::TrajectoryListBox3D::getScrollPosition ( ) const
inline

Returns the value of the ScrollPositionProperty.

Returns
The current scroll position of the TrajectoryListBox3D node.
See also
setScrollPosition()
Since
Kanzi 3.9.0

◆ setScrollPosition()

void kanzi::TrajectoryListBox3D::setScrollPosition ( Vector2 scrollPosition)
inline

Sets the value of the ScrollPositionProperty.

Parameters
scrollPositionThe scroll position to set for the TrajectoryListBox3D node.
See also
getScrollPosition()
Since
Kanzi 3.9.0

◆ isAlignToTangent()

bool kanzi::TrajectoryListBox3D::isAlignToTangent ( ) const
inline

Gets the value of the AlignToTangentProperty.

See also
setAlignToTangent()

◆ setAlignToTangent()

void kanzi::TrajectoryListBox3D::setAlignToTangent ( bool value)
inline

Sets the value of the AlignToTangentProperty.

See also
isAlignToTangent()

◆ getSpacing()

float kanzi::TrajectoryListBox3D::getSpacing ( ) const
inline

Gets the value of the SpacingProperty.

See also
setSpacing()

◆ setSpacing()

void kanzi::TrajectoryListBox3D::setSpacing ( float value)
inline

Sets the value of the SpacingProperty.

See also
getSpacing()

◆ getCursorOffset()

float kanzi::TrajectoryListBox3D::getCursorOffset ( ) const
inline

Gets the value of the CursorOffsetProperty.

See also
setCursorOffset()

◆ setCursorOffset()

void kanzi::TrajectoryListBox3D::setCursorOffset ( float value)
inline

Sets the value of the CursorOffsetProperty.

See also
getCursorOffset()

◆ getRecognitionThreshold()

float kanzi::TrajectoryListBox3D::getRecognitionThreshold ( ) const
inline

◆ setRecognitionThreshold()

void kanzi::TrajectoryListBox3D::setRecognitionThreshold ( float value)
inline

◆ getMinimumNumberOfTouches()

int kanzi::TrajectoryListBox3D::getMinimumNumberOfTouches ( ) const
inline

◆ setMinimumNumberOfTouches()

void kanzi::TrajectoryListBox3D::setMinimumNumberOfTouches ( int value)
inline

◆ getMaximumNumberOfTouches()

int kanzi::TrajectoryListBox3D::getMaximumNumberOfTouches ( ) const
inline

◆ setMaximumNumberOfTouches()

void kanzi::TrajectoryListBox3D::setMaximumNumberOfTouches ( int value)
inline

◆ getSensitivity()

float kanzi::TrajectoryListBox3D::getSensitivity ( ) const
inline

Gets the value of the SensitivityProperty.

See also
setSensitivity()

◆ setSensitivity()

void kanzi::TrajectoryListBox3D::setSensitivity ( float value)
inline

Sets the value of the SensitivityProperty.

See also
getSensitivity()

◆ getSlidingAccelerationCoefficient()

float kanzi::TrajectoryListBox3D::getSlidingAccelerationCoefficient ( ) const
inline

◆ setSlidingAccelerationCoefficient()

void kanzi::TrajectoryListBox3D::setSlidingAccelerationCoefficient ( float value)
inline

◆ getSlidingDragCoefficient()

float kanzi::TrajectoryListBox3D::getSlidingDragCoefficient ( ) const
inline

◆ setSlidingDragCoefficient()

void kanzi::TrajectoryListBox3D::setSlidingDragCoefficient ( float value)
inline

◆ getDraggingAccelerationCoefficient()

float kanzi::TrajectoryListBox3D::getDraggingAccelerationCoefficient ( ) const
inline

◆ setDraggingAccelerationCoefficient()

void kanzi::TrajectoryListBox3D::setDraggingAccelerationCoefficient ( float value)
inline

◆ getDraggingDragCoefficient()

float kanzi::TrajectoryListBox3D::getDraggingDragCoefficient ( ) const
inline

◆ setDraggingDragCoefficient()

void kanzi::TrajectoryListBox3D::setDraggingDragCoefficient ( float value)
inline

◆ getDraggingImpulseFactor()

float kanzi::TrajectoryListBox3D::getDraggingImpulseFactor ( ) const
inline

◆ setDraggingImpulseFactor()

void kanzi::TrajectoryListBox3D::setDraggingImpulseFactor ( float value)
inline

◆ getSwipeDistance()

float kanzi::TrajectoryListBox3D::getSwipeDistance ( ) const
inline

Gets the value of the SwipeDistanceProperty.

See also
setSwipeDistance()

◆ setSwipeDistance()

void kanzi::TrajectoryListBox3D::setSwipeDistance ( float value)
inline

Sets the value of the SwipeDistanceProperty.

See also
getSwipeDistance()

◆ isLooping()

bool kanzi::TrajectoryListBox3D::isLooping ( ) const
inline

Gets the value of the LoopingProperty.

See also
setLooping()

◆ setLooping()

void kanzi::TrajectoryListBox3D::setLooping ( bool value)
inline

Sets the value of the LoopingProperty.

See also
isLooping()

◆ getAllowedScrollAxis()

ScrollViewConcept::AllowedScrollAxis kanzi::TrajectoryListBox3D::getAllowedScrollAxis ( ) const
inline

Returns the value of the AllowedScrollAxisProperty.

See also
setAllowedScrollAxis()

◆ setAllowedScrollAxis()

void kanzi::TrajectoryListBox3D::setAllowedScrollAxis ( ScrollViewConcept::AllowedScrollAxis axis)
inline

Sets the AllowedScrollAxisProperty value.

Parameters
axisThe axis on which you want to allow scrolling.
See also
getAllowedScrollAxis()

◆ isReversedScrolling()

bool kanzi::TrajectoryListBox3D::isReversedScrolling ( ) const
inline

Returns the value of the ReversedScrollingProperty.

See also
setReversedSScrolling()
Since
Kanzi 3.9.7

◆ setReversedScrolling()

void kanzi::TrajectoryListBox3D::setReversedScrolling ( bool enable)
inline

Sets the value of the ReversedScrollingProperty.

Parameters
enableTo reverse the direction of scrolling, pass true, otherwise false.
See also
isReversedScrolling()
Since
Kanzi 3.9.7

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryListBox3D::makeEditorInfo ( )
static

◆ getScrollView()

ScrollView3DSharedPtr kanzi::TrajectoryListBox3D::getScrollView ( ) const
inline

Returns the Scroll View that scrolls the Trajectory List Box 3D.

Use this function to access the properties of the Scroll View or to modify the scrolling behavior.

Returns
The Scroll View that scrolls the Trajectory List Box 3D.

◆ initialize()

void kanzi::TrajectoryListBox3D::initialize ( )
protected

◆ onAttached()

void kanzi::TrajectoryListBox3D::onAttached ( )
overrideprotectedvirtual

◆ onNodePropertyChanged()

void kanzi::TrajectoryListBox3D::onNodePropertyChanged ( AbstractPropertyType propertyType,
PropertyNotificationReason reason )
overrideprotectedvirtual

Member Data Documentation

◆ TrajectoryProperty

PropertyType<ResourceSharedPtr> kanzi::TrajectoryListBox3D::TrajectoryProperty
static

Sets the resource ID of the Trajectory along which the Trajectory List Box 3D arranges its items.

The default value is ResourceSharedPtr().

See also
setTrajectory(), getTrajectory()

◆ ItemAreaBeginProperty

PropertyType<float> kanzi::TrajectoryListBox3D::ItemAreaBeginProperty
static

Defines the starting point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

Kanzi uses the values of the ItemAreaBeginProperty and ItemAreaEndProperty properties to calculate the value of the Node::VisibleAmountInParentProperty property for each list item. You can use the VisibleAmountInParentProperty in shaders to fade out those list items that are not fully visible.

The value is in the [0, 1] range where 0 is the beginning and 1 is the end of the trajectory.

The default value is 0.0f.

See also
setItemAreaBegin(), getItemAreaBegin()

◆ ItemAreaEndProperty

PropertyType<float> kanzi::TrajectoryListBox3D::ItemAreaEndProperty
static

Defines the ending point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

Kanzi uses the values of the ItemAreaBeginProperty and ItemAreaEndProperty properties to calculate the value of the Node::VisibleAmountInParentProperty property for each list item. You can use the VisibleAmountInParentProperty in shaders to fade out those list items that are not fully visible.

The value is in the [0, 1] range where 0 is the beginning and 1 is the end of the trajectory.

The default value is 1.0f.

See also
setItemAreaEnd(), getItemAreaEnd()

◆ ScrollPositionProperty

PropertyType<Vector2> kanzi::TrajectoryListBox3D::ScrollPositionProperty
static

Reports the scroll position of a Trajectory List Box 3D node along the x and y axes as a relative position within the Trajectory List Box 3D 3D area.

Use this property to move the list to a scroll position immediately, without scrolling. To update the scroll position with a binding, use a TwoWayBinding or ToSourceBinding. During scrolling the Trajectory List Box 3D node internally overrides any one-way binding that targets this property.

The default value is Vector2(0.0f, 0.0f).

See also
setScrollPosition(), getScrollPosition()
Since
Kanzi 3.9.0

◆ AlignToTangentProperty

PropertyType<bool> kanzi::TrajectoryListBox3D::AlignToTangentProperty
static

Indicates whether to align the Trajectory List Box 3D items to match the tangent of the Trajectory.

The default value is false.

See also
setAlignToTangent(), isAlignToTangent()

◆ SpacingProperty

PropertyType<float> kanzi::TrajectoryListBox3D::SpacingProperty
static

Sets the distance between the items in the Trajectory List Box 3D node.

The default value is 0.0f.

See also
setSpacing(), getSpacing()

◆ CursorOffsetProperty

PropertyType<float> kanzi::TrajectoryListBox3D::CursorOffsetProperty
static

Sets the offset of the position to use to select the active item, in proportional range [0,1].

The default value is 0.5f.

See also
setCursorOffset(), getCursorOffset()

◆ RecognitionThresholdProperty

PropertyType<float> kanzi::TrajectoryListBox3D::RecognitionThresholdProperty
static

Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D node.

The default value is 5.0f.

See also
setRecognitionThreshold(), getRecognitionThreshold()

◆ MinimumNumberOfTouchesProperty

PropertyType<int> kanzi::TrajectoryListBox3D::MinimumNumberOfTouchesProperty
static

Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling.

The default value is 1.

See also
setMinimumNumberOfTouches(), getMinimumNumberOfTouches()

◆ MaximumNumberOfTouchesProperty

PropertyType<int> kanzi::TrajectoryListBox3D::MaximumNumberOfTouchesProperty
static

Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling.

The default value is 10.

See also
setMaximumNumberOfTouches(), getMaximumNumberOfTouches()

◆ SensitivityProperty

PropertyType<float> kanzi::TrajectoryListBox3D::SensitivityProperty
static

Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of a Trajectory List Box 3D node.

The default value 1.0f makes the Trajectory List Box 3D scroll the same amount as the user drags the pointer. For example, to set a Trajectory List Box 3D to scroll twice the amount that the user drags the pointer, set the value of the property to 2.0f.

See also
setSensitivity(), getSensitivity()

◆ SlidingAccelerationCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBox3D::SlidingAccelerationCoefficientProperty
static

Sets the acceleration of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

The higher the value, the quicker the Trajectory List Box 3D reaches the scroll target.

The default value is 40.0f.

See also
setSlidingAccelerationCoefficient(), getSlidingAccelerationCoefficient()

◆ SlidingDragCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBox3D::SlidingDragCoefficientProperty
static

Sets the amount that drag affects the movement of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

The lower the value, the higher the drag and the quicker the scrolling of the Trajectory List Box 3D stops.

The default value is 80.0f.

See also
setSlidingDragCoefficient(), getSlidingDragCoefficient()

◆ DraggingAccelerationCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBox3D::DraggingAccelerationCoefficientProperty
static

Sets the acceleration of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

The higher the value, the quicker the Trajectory List Box 3D reaches its final position.

The default value is 80.0f.

See also
setDraggingAccelerationCoefficient(), getDraggingAccelerationCoefficient()

◆ DraggingDragCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBox3D::DraggingDragCoefficientProperty
static

Sets the amount that drag affects the movement of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

The lower the value, the higher the drag and the quicker the scrolling stops.

The default value is 150.0f.

See also
setDraggingDragCoefficient(), getDraggingDragCoefficient()

◆ DraggingImpulseFactorProperty

PropertyType<float> kanzi::TrajectoryListBox3D::DraggingImpulseFactorProperty
static

Sets the amount of impulse to generate from the pointer movement when the user scrolls a Trajectory List Box 3D node by dragging the pointer.

The default value is 2.0f.

See also
setDraggingImpulseFactor(), getDraggingImpulseFactor()

◆ SwipeDistanceProperty

PropertyType<float> kanzi::TrajectoryListBox3D::SwipeDistanceProperty
static

Sets the distance that a swipe sends the scroll value in a Trajectory List Box 3D node, relative to the speed of the pointer.

The default value is 0.005f.

See also
setSwipeDistance(), getSwipeDistance()

◆ LoopingProperty

PropertyType<bool> kanzi::TrajectoryListBox3D::LoopingProperty
static

Indicates whether to show items in a Trajectory List Box 3D from the beginning after reaching the last item, and the other way around.

The default value is false.

See also
setLooping(), isLooping()

◆ AllowedScrollAxisProperty

PropertyType<ScrollViewConcept::AllowedScrollAxis> kanzi::TrajectoryListBox3D::AllowedScrollAxisProperty
static

Sets the axis on which you want to allow a Trajectory List Box 3D node to scroll.

The default value is ScrollViewConcept::AllAxes.

See also
ScrollViewConcept::AllowedScrollAxisProperty, getAllowedScrollAxis(), setAllowedScrollAxis()

◆ ReversedScrollingProperty

PropertyType<bool> kanzi::TrajectoryListBox3D::ReversedScrollingProperty
static

Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture.

The default value, False, sets the scroll position to decrease in relation to the pan direction, which makes the list items move toward the direction of the trajectory.

Since
Kanzi 3.9.7

The documentation for this class was generated from the following file: